home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / pc_board / pcbdesc2.zip / PCBDESC.DOC < prev    next >
Text File  |  1991-10-16  |  5KB  |  111 lines
  1.                              PCBDESC Version 2.00
  2.           Automatic Upload Description Insertion for PCBoard 14.5a
  3.  
  4.     Copyright (c) 1991 by Clark Development Co., Inc.  All Rights Reserved
  5.  
  6.  
  7.         PCBDESC.EXE checks uploaded files for FILE_ID.DIZ (Description In
  8. Zipfile) files provided by the program author.  If the uploaded file
  9. contains a description file, it will replace the user supplied description
  10. with the one provided in the file.
  11.  
  12.         Also, PCBDESC can optionally append a line to the description
  13. showing the number of files and the dates of both the oldest and the newest
  14. files in the zipfile.
  15.  
  16. INSTALLING PCBDESC:
  17.         PCBDESC *REQUIRES* PCBoard version 14.5a or higher BBS software to
  18. operate.  Earlier versions of PCBoard, or other BBS software packages are NOT
  19. compatible with PCBDESC.
  20.  
  21.         PCBDESC is used inside of the PCBTEST.BAT file, which is run to test
  22. each upload to the system.  Place the PCBDESC.EXE file in your default \PCB
  23. directory, and insert the following line into PCBTEST.BAT:
  24.  
  25.                   IF %2==UPLOAD PCBDESC %1 %3
  26.  
  27.         And it's ready to go.  There is only one option; if you would like
  28. to have an additional line in the description showing the date of the oldest
  29. and newest files in the ZIP, then use this command instead:
  30.  
  31.                   IF %2==UPLOAD PCBDESC /D %1 %3
  32.  
  33.         The word "UPLOAD" in the above example is case sensitive.  Make sure
  34. you type it in uppercase letters.  Also make sure that you have a copy of
  35. PKUNZIP.EXE available in your default \PCB directory, or in a subdirectory
  36. referenced by your PATH.
  37.  
  38.         PCBDESC can be the first thing in your PCBTEST.BAT file; it will only
  39. operate on ZIP and self-extracting EXE format ZIP files.
  40.  
  41. ERRORLEVEL RETURNS:
  42.         PCBDESC will return errorlevels to your batch file to indicate what
  43. it has done.  These errorlevels can then be tested and used for your own
  44. purposes.  Return values are as follows:
  45.  
  46.         0     =    No processing performed
  47.         1     =    File was not a ZIP/EXE file or ZIP contents were damaged
  48.         2     =    Desciption was updated (or file dates added)
  49.         3     =    Found description but unable to process
  50.  
  51.  
  52. THE DESCRIPTION FILE:
  53.         PCBDESC will accept descriptions contained in FILE_ID.DIZ files
  54. found in the ZIP being tested.  The FILE_ID.DIZ file is an ASCII text file,
  55. and can contain up to 10 lines of 45 characters each.  The first line of
  56. this file is the program name and version, and the following lines describe
  57. the function of the program.
  58.  
  59. -----------------------------------------------------------------------------
  60.         ATTENTION!  The FILE_ID.DIZ file is intended for the program
  61. author's use in providing a coherent description of his program.  In this
  62. way, the author and the sysop can be assured that the program will be
  63. properly described when uploaded to a BBS.  DO NOT use this file for BBS
  64. advertising - such use is in violation of the copyright associated with the
  65. FILE_ID.DIZ file.
  66. -----------------------------------------------------------------------------
  67.  
  68.         PCBDESC will also detect and use descriptions contained in DESC.SDI
  69. files if they are present.  No other description file formats are supported.
  70.  
  71.  
  72. REVISION HISTORY:
  73.         Version 1.00 - Original Release
  74.  
  75.         Version 1.10 - Maintainence Release
  76.         -----------------------------------
  77.         If a stray description file was left in the default directory,
  78.         PCBDESC could stick on it.  Fixed.
  79.  
  80.         And to prevent problems for those who insist on using PCBDESC with
  81.         the wrong BBS software:
  82.         Added testing for improper version of PCBoard software.
  83.         Added testing for proper filespecs on command line.
  84.  
  85.         Updated documentation to include the exit codes returned by PCBDESC.
  86.  
  87.         Version 1.11 - Bug Fix Release
  88.         ------------------------------
  89.  
  90.         Error 53 at 4626 caused by incorrect call to PKUNZIP.  Sorry about
  91.         that, folks.  Fixed.
  92.  
  93.         Version 2.00 - Rewrite in C
  94.         ---------------------------
  95.         Made the program both smaller and faster
  96.  
  97.         Fixed a problem with running on Alloy Slave Cards
  98.  
  99.         Changed date line from "Latest File Date in ZIP: MM/DD/YY" to "Files: #
  100.         Oldest: MM/DD/YY  Newest: MM/DD/YY"
  101.  
  102.         Added ERRORLEVEL 2 if a description file was found and processed
  103.  
  104.         PLEASE NOTE:
  105.         ------------
  106.         Previous recommended usage was:   PCBDESC [/D] %1 %3
  107.         Current recommend usage is now:   IF %2 == UPLOAD PCBDESC [/D] %1 %3
  108.  
  109.         The change avoids running PCBDESC if PCBoard's "TEST" command is being
  110.         used instead of executing an upload test procedure.
  111.